Salesforce UX API
TMF-677 GET usageConsumptionReport
TMF-677 GET Subscription Query wallet - ( towards Matrixx system)
This operation is used to List usage consumption report from Matrixx system
URL
https://[localhost]:[port]/sfdc-ux/v1/{businessId}/usageConsumptionReporturl Param
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. | Y |
Header
| name | type | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y |
| channelId | string | Channel to business | Y |
| lob | string | The Line of Business Identifier currently available are: FIXED PREPAID POSTPAID | N |
| targetSystem | string | This describes the target system. โMatrixxโ is in scope. | Y |
Query Param
| name | type | description | required |
|---|---|---|---|
| product.publicIdentifier | string | Value of the public identifier | Y |
| product.publicIdentifierType | string | Type of public identifier type value. Expected values are MSISDN or SubscriptionId. Note - Either MSISDN or SubscriptionId should be expected | Y |
cURL request
curl --location 'https://nonprod.esb.cloud.lla.com/test/sfdc-ux/sfdc-ux/v1/PR/usageConsumptionReport?product.publicIdentifier=00217256_0001265248&product.publicIdentifierType=SubscriptionId' \
--header 'X-Correlation-Id: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b' \
--header 'lob: POSTPAID' \
--header 'channelId: SFDC-B2C' \
--header 'targetSystem: MATRIXX' \
--header 'client_id: abcde' \
--header 'client_secret: 3845906'Response
In this section all the possible data structures received by the client at the moment of responding the method are defined.
Possible response success
This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.
[ 200 ]
OK - list Usage Consumption request processed successfully, response body contains an entity corresponding to the requested resource.
Note
- Added a new mapping under 'bucket.characteristic' for the 'Amount', where 'bucket.characteristic.name' represents the amount or count associated with each 'bucket.name'.
- If the backend response (Matrixx) contains 'Amount', then the ESB response will also contain the 'Amount' object under 'bucket.characteristic' otherwise, the ESB response will not contain it.
[
{
"description": "Usage Consumption Report for SubscriptionId 00217256_0001265248",
"effectiveDate": "2025-08-01T09:25:48",
"@type": "UsageConsumptionReport",
"characteristic": [],
"bucket": [
{
"id": "1",
"name": "Prepaid Balance",
"usageType": "United States dollar",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "-30.0", //New mapping, amount or count associated with 'bucket.name'.
"name": "Amount"
},
{
"value": "30",
"name": "AvailableAmount"
},
{
"value": "2025-06-18T06:32:17",
"name": "StartTime"
},
{
"value": "0",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsPeriodic"
},
{
"value": "true",
"name": "IsPrepaid"
},
{
"value": "false",
"name": "IsPrivate"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "45.01",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "00217256_0001265248"
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "Notify_Gross",
"value": {
"amount": 0,
"units": "none"
},
"valueName": "Limit"
},
{
"counterType": "Threshold_available_amount",
"level": "Notify_Gross,Notify_BalIncr,Notify_IncrEq",
"value": {
"amount": 20,
"units": "none"
},
"valueName": "20Absolute #514"
},
{
"counterType": "Threshold_available_amount",
"level": "Notify_Gross,Notify_BalIncr,Notify_IncrEq",
"value": {
"amount": 0,
"units": "none"
},
"valueName": "ZeroAbsolute #515"
},
{
"counterType": "Threshold_balance_floor",
"level": "Notify_Gross",
"value": {
"amount": -1000,
"units": "none"
},
"valueName": "MaxBalance"
},
{
"counterType": "Threshold_balance_amount",
"level": "Notify_Gross,Notify_BalDecr,Notify_DecrEq",
"value": {
"amount": -800,
"units": "none"
},
"valueName": "800Absolute #1014"
},
{
"counterType": "Threshold_balance_amount",
"level": "Notify_Gross,Notify_BalDecr,Notify_DecrEq",
"value": {
"amount": -1000,
"units": "none"
},
"valueName": "1000Absolute #1015"
}
]
},
{
"id": "2",
"name": "RenewalCount",
"usageType": "Number",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "-2.0", //New mapping, amount or count associated with 'bucket.name'.
"name": "Amount"
},
{
"value": "infinity",
"name": "AvailableAmount"
},
{
"value": "2025-06-18T06:32:17",
"name": "StartTime"
},
{
"value": "infinity",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsPeriodic"
},
{
"value": "false",
"name": "IsPrepaid"
},
{
"value": "false",
"name": "IsPrivate"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "infinity",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "00217256_0001265248"
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "Notify_Gross",
"value": {
"amount": "infinity",
"units": "none"
},
"valueName": "credit_limit"
}
]
},
{
"id": "3",
"name": "Overdraft",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "0.0", //New mapping, amount or count associated with 'bucket.name'.
"name": "Amount"
},
{
"value": "0.01",
"name": "AvailableAmount"
},
{
"value": "0.01",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsPeriodic"
},
{
"value": "false",
"name": "IsPrepaid"
},
{
"value": "false",
"name": "IsPrivate"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "0.01",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "00217256_0001265248"
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "Notify_Gross,Notify_IncrEq,Notify_DecrEq",
"value": {
"amount": 0.01,
"units": "none"
},
"valueName": "Limit"
}
]
},
{
"id": "5",
"name": "Setup_Flag_Balance",
"usageType": "Flag",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "0.0", //New mapping, amount or count associated with 'bucket.name'.
"name": "Amount"
},
{
"value": "infinity",
"name": "AvailableAmount"
},
{
"value": "2025-06-18T06:32:40",
"name": "StartTime"
},
{
"value": "infinity",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsPeriodic"
},
{
"value": "false",
"name": "IsPrepaid"
},
{
"value": "false",
"name": "IsPrivate"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "infinity",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "00217256_0001265248"
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "",
"value": {
"amount": "infinity",
"units": "none"
},
"valueName": "Credit Limit"
}
]
},
{
"id": "6",
"name": "Flag - Unlimited Internet usage",
"usageType": "Flag",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "0.0", //New mapping, amount or count associated with 'bucket.name'.
"name": "Amount"
},
{
"value": "infinity",
"name": "AvailableAmount"
},
{
"value": "2025-06-18T06:32:40",
"name": "StartTime"
},
{
"value": "infinity",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsPeriodic"
},
{
"value": "false",
"name": "IsPrepaid"
},
{
"value": "false",
"name": "IsPrivate"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "infinity",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "00217256_0001265248"
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "",
"value": {
"amount": "infinity",
"units": "none"
},
"valueName": "Credit Limit"
}
]
},
{
"id": "7",
"name": "Flag - Unlimited Hotspot usage",
"usageType": "Flag",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "0.0", //New mapping, amount or count associated with 'bucket.name'.
"name": "Amount"
},
{
"value": "infinity",
"name": "AvailableAmount"
},
{
"value": "2025-06-18T06:32:40",
"name": "StartTime"
},
{
"value": "infinity",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsPeriodic"
},
{
"value": "false",
"name": "IsPrepaid"
},
{
"value": "false",
"name": "IsPrivate"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "infinity",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "00217256_0001265248"
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "",
"value": {
"amount": "infinity",
"units": "none"
},
"valueName": "Credit Limit"
}
]
},
{
"id": "15",
"name": "Prepaid Group Discount",
"usageType": "Flag",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "0.0", //New mapping, amount or count associated with 'bucket.name'.
"name": "Amount"
},
{
"value": "12",
"name": "AvailableAmount"
},
{
"value": "12",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsPeriodic"
},
{
"value": "false",
"name": "IsPrepaid"
},
{
"value": "false",
"name": "IsPrivate"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "12",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "00217256_0001265248"
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "Notify_Gross",
"value": {
"amount": 12,
"units": "none"
},
"valueName": "Limit"
}
]
},
{
"id": "18",
"name": "Discount1Validity",
"usageType": "Flag",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "1.0", //New mapping, amount or count associated with 'bucket.name'.
"name": "Amount"
},
{
"value": "0",
"name": "AvailableAmount"
},
{
"value": "2045-06-19T00:00:00",
"name": "EndTime"
},
{
"value": "1",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsPeriodic"
},
{
"value": "false",
"name": "IsPrepaid"
},
{
"value": "false",
"name": "IsPrivate"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "1",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "00217256_0001265248"
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "Notify_Gross,Notify_IncrEq,Notify_DecrEq",
"value": {
"amount": 1,
"units": "none"
},
"valueName": "credit_limit"
}
]
},
{
"id": "19",
"name": "Discount2Validity",
"usageType": "Flag",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "1.0", //New mapping, amount or count associated with 'bucket.name'.
"name": "Amount"
},
{
"value": "0",
"name": "AvailableAmount"
},
{
"value": "2045-06-19T00:00:00",
"name": "EndTime"
},
{
"value": "1",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsPeriodic"
},
{
"value": "false",
"name": "IsPrepaid"
},
{
"value": "false",
"name": "IsPrivate"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "1",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "00217256_0001265248"
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "Notify_Gross,Notify_IncrEq,Notify_DecrEq",
"value": {
"amount": 1,
"units": "none"
},
"valueName": "credit_limit"
}
]
},
{
"id": "8",
"name": "Included MMS - Prepaid",
"usageType": "Picture",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "-999999.0", //New mapping, amount or count associated with 'bucket.name'.
"name": "Amount"
},
{
"value": "999999",
"name": "AvailableAmount"
},
{
"value": "2025-06-18T06:32:40",
"name": "BalanceStartTime"
},
{
"value": "2025-07-18T00:00:00",
"name": "StartTime"
},
{
"value": "2025-08-17T00:00:00",
"name": "EndTime"
},
{
"value": "0",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsBillingCyclePeriodic"
},
{
"value": "false",
"name": "IsCompositeMeter"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsOnDemand"
},
{
"value": "true",
"name": "IsPeriodic"
},
{
"value": "true",
"name": "IsPrepaid"
},
{
"value": "false",
"name": "IsPrivate"
},
{
"value": "true",
"name": "IsPurchasedItemCyclePeriodic"
},
{
"value": "false",
"name": "IsRenewable"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "999999",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "00217256_0001265248"
}
],
"bucketBalance": [
{
"remainingValueName": "999999",
"remainingValue": {
"amount": 999999
},
"validFor": {
"startDateTime": "2025-06-18T00:00:00",
"endDateTime": "2025-07-18T00:00:00"
},
"characteristic": [
{
"value": "999999",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "999999",
"remainingValue": {
"amount": 999999
},
"validFor": {
"startDateTime": "2025-07-18T00:00:00",
"endDateTime": "2025-08-17T00:00:00"
},
"characteristic": [
{
"value": "999999",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "true",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "0",
"remainingValue": {
"amount": 0
},
"validFor": {
"startDateTime": "2025-08-17T00:00:00",
"endDateTime": "2025-09-16T00:00:00"
},
"characteristic": [
{
"value": "0",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "Notify_Gross",
"value": {
"amount": 0,
"units": "none"
},
"valueName": "Bal"
}
]
},
{
"id": "9",
"name": "Included Data - Prepaid",
"usageType": "Data",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "-999999.0", //New mapping, amount or count associated with 'bucket.name'.
"name": "Amount"
},
{
"value": "999999",
"name": "AvailableAmount"
},
{
"value": "2025-06-18T06:32:40",
"name": "BalanceStartTime"
},
{
"value": "2025-07-18T00:00:00",
"name": "StartTime"
},
{
"value": "2025-08-17T00:00:00",
"name": "EndTime"
},
{
"value": "0",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsBillingCyclePeriodic"
},
{
"value": "false",
"name": "IsCompositeMeter"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsOnDemand"
},
{
"value": "true",
"name": "IsPeriodic"
},
{
"value": "true",
"name": "IsPrepaid"
},
{
"value": "true",
"name": "IsPrivate"
},
{
"value": "true",
"name": "IsPurchasedItemCyclePeriodic"
},
{
"value": "false",
"name": "IsRenewable"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "0",
"name": "RolloverInitAmountTotal"
},
{
"value": "999999",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "00217256_0001265248"
}
],
"bucketBalance": [
{
"remainingValueName": "999999 megabytes",
"remainingValue": {
"amount": 999999,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2025-06-18T00:00:00",
"endDateTime": "2025-07-18T00:00:00"
},
"characteristic": [
{
"value": "999999",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "999999 megabytes",
"remainingValue": {
"amount": 999999,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2025-07-18T00:00:00",
"endDateTime": "2025-08-17T00:00:00"
},
"characteristic": [
{
"value": "999999",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "true",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "0 megabytes",
"remainingValue": {
"amount": 0,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2025-08-17T00:00:00",
"endDateTime": "2025-09-16T00:00:00"
},
"characteristic": [
{
"value": "0",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "0 megabytes",
"remainingValue": {
"amount": 0,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2025-09-16T00:00:00",
"endDateTime": "2025-10-16T00:00:00"
},
"characteristic": [
{
"value": "0",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "Notify_Gross",
"value": {
"amount": 0,
"units": "megabytes"
},
"valueName": "Bal"
},
{
"counterType": "Threshold_available_amount",
"level": "Notify_Gross",
"value": {
"amount": 100,
"units": "megabytes"
},
"valueName": "recurring data threshold"
},
{
"counterType": "Threshold_consumed_amount",
"level": "Notify_Gross,Notify_BalIncr,Notify_IncrEq",
"value": {
"amount": 75,
"units": "megabytes"
},
"valueName": "75Percent #501"
},
{
"counterType": "Threshold_consumed_amount",
"level": "Notify_Gross,Notify_BalIncr,Notify_IncrEq",
"value": {
"amount": 90,
"units": "megabytes"
},
"valueName": "90Percent #502"
},
{
"counterType": "Threshold_consumed_amount",
"level": "Notify_Gross,Notify_BalIncr,Notify_IncrEq",
"value": {
"amount": 100,
"units": "megabytes"
},
"valueName": "100Percent #503"
},
{
"counterType": "Threshold_available_amount",
"level": "Notify_Gross,Notify_BalIncr,Notify_IncrEq",
"value": {
"amount": 0,
"units": "megabytes"
},
"valueName": "Bal_Zero"
}
]
},
{
"id": "10",
"name": "HotSpot Data - Prepaid",
"usageType": "Data",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "-25600.0", //New mapping, amount or count associated with 'bucket.name'.
"name": "Amount"
},
{
"value": "25600",
"name": "AvailableAmount"
},
{
"value": "2025-06-18T06:32:40",
"name": "BalanceStartTime"
},
{
"value": "2025-07-18T00:00:00",
"name": "StartTime"
},
{
"value": "2025-08-17T00:00:00",
"name": "EndTime"
},
{
"value": "0",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsBillingCyclePeriodic"
},
{
"value": "false",
"name": "IsCompositeMeter"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsOnDemand"
},
{
"value": "true",
"name": "IsPeriodic"
},
{
"value": "true",
"name": "IsPrepaid"
},
{
"value": "true",
"name": "IsPrivate"
},
{
"value": "true",
"name": "IsPurchasedItemCyclePeriodic"
},
{
"value": "false",
"name": "IsRenewable"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "25600",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "00217256_0001265248"
}
],
"bucketBalance": [
{
"remainingValueName": "25600 megabytes",
"remainingValue": {
"amount": 25600,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2025-06-18T00:00:00",
"endDateTime": "2025-07-18T00:00:00"
},
"characteristic": [
{
"value": "25600",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "25600 megabytes",
"remainingValue": {
"amount": 25600,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2025-07-18T00:00:00",
"endDateTime": "2025-08-17T00:00:00"
},
"characteristic": [
{
"value": "25600",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "true",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "0 megabytes",
"remainingValue": {
"amount": 0,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2025-08-17T00:00:00",
"endDateTime": "2025-09-16T00:00:00"
},
"characteristic": [
{
"value": "0",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "Notify_Gross",
"value": {
"amount": 0,
"units": "megabytes"
},
"valueName": "bal"
}
]
},
{
"id": "11",
"name": "DataPrioritization Balance - Prepaid",
"usageType": "Data",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "0.0", //New mapping, amount or count associated with 'bucket.name'.
"name": "Amount"
},
{
"value": "0",
"name": "AvailableAmount"
},
{
"value": "2025-06-18T06:32:40",
"name": "BalanceStartTime"
},
{
"value": "2025-07-18T06:32:40",
"name": "StartTime"
},
{
"value": "2025-08-17T06:32:40",
"name": "EndTime"
},
{
"value": "0",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsBillingCyclePeriodic"
},
{
"value": "false",
"name": "IsCompositeMeter"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsOnDemand"
},
{
"value": "true",
"name": "IsPeriodic"
},
{
"value": "true",
"name": "IsPrepaid"
},
{
"value": "true",
"name": "IsPrivate"
},
{
"value": "false",
"name": "IsPurchasedItemCyclePeriodic"
},
{
"value": "false",
"name": "IsRenewable"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "0",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "00217256_0001265248"
}
],
"bucketBalance": [
{
"remainingValueName": "71680 megabytes",
"remainingValue": {
"amount": 71680,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2025-06-18T06:32:40",
"endDateTime": "2025-07-18T06:32:40"
},
"characteristic": [
{
"value": "71680",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "0 megabytes",
"remainingValue": {
"amount": 0,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2025-07-18T06:32:40",
"endDateTime": "2025-08-17T06:32:40"
},
"characteristic": [
{
"value": "0",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "true",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "0 megabytes",
"remainingValue": {
"amount": 0,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2025-08-17T06:32:40",
"endDateTime": "2025-09-16T06:32:40"
},
"characteristic": [
{
"value": "0",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "Notify_Gross",
"value": {
"amount": 0,
"units": "megabytes"
},
"valueName": "bal"
},
{
"counterType": "Threshold_consumed_amount",
"level": "Notify_Gross,Notify_BalIncr,Notify_IncrEq",
"value": {
"amount": 75,
"units": "megabytes"
},
"valueName": "75Percent"
},
{
"counterType": "Threshold_consumed_amount",
"level": "Notify_Gross,Notify_BalIncr,Notify_IncrEq",
"value": {
"amount": 90,
"units": "megabytes"
},
"valueName": "90Percent"
},
{
"counterType": "Threshold_consumed_amount",
"level": "Notify_Gross,Notify_BalIncr,Notify_IncrEq",
"value": {
"amount": 100,
"units": "megabytes"
},
"valueName": "100Percent"
}
]
},
{
"id": "12",
"name": "Data Usage Meter - Prepaid",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "0.0", //New mapping, amount or count associated with 'bucket.name'.
"name": "Amount"
},
{
"value": "infinity",
"name": "AvailableAmount"
},
{
"value": "2025-06-18T06:32:40",
"name": "BalanceStartTime"
},
{
"value": "2025-07-18T00:00:00",
"name": "StartTime"
},
{
"value": "2025-08-17T00:00:00",
"name": "EndTime"
},
{
"value": "infinity",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsBillingCyclePeriodic"
},
{
"value": "false",
"name": "IsCompositeMeter"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsOnDemand"
},
{
"value": "true",
"name": "IsPeriodic"
},
{
"value": "false",
"name": "IsPrepaid"
},
{
"value": "false",
"name": "IsPrivate"
},
{
"value": "true",
"name": "IsPurchasedItemCyclePeriodic"
},
{
"value": "false",
"name": "IsRenewable"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "infinity",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "00217256_0001265248"
}
],
"bucketBalance": [
{
"remainingValueName": "0 gigabytes",
"remainingValue": {
"amount": 0,
"units": "gigabytes"
},
"validFor": {
"startDateTime": "2025-06-18T00:00:00",
"endDateTime": "2025-07-18T00:00:00"
},
"characteristic": [
{
"value": "infinity",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "0 gigabytes",
"remainingValue": {
"amount": 0,
"units": "gigabytes"
},
"validFor": {
"startDateTime": "2025-07-18T00:00:00",
"endDateTime": "2025-08-17T00:00:00"
},
"characteristic": [
{
"value": "infinity",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "true",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "0 gigabytes",
"remainingValue": {
"amount": 0,
"units": "gigabytes"
},
"validFor": {
"startDateTime": "2025-08-17T00:00:00",
"endDateTime": "2025-09-16T00:00:00"
},
"characteristic": [
{
"value": "infinity",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "Notify_Gross,Notify_IncrEq,Notify_DecrEq",
"value": {
"amount": "infinity",
"units": "gigabytes"
},
"valueName": "Credit Limit"
}
]
},
{
"id": "13",
"name": "RG20000 Data Usage Meter - Prepaid",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "0.0", //New mapping, amount or count associated with 'bucket.name'.
"name": "Amount"
},
{
"value": "infinity",
"name": "AvailableAmount"
},
{
"value": "2025-06-18T06:32:40",
"name": "BalanceStartTime"
},
{
"value": "2025-07-18T00:00:00",
"name": "StartTime"
},
{
"value": "2025-08-17T00:00:00",
"name": "EndTime"
},
{
"value": "infinity",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsBillingCyclePeriodic"
},
{
"value": "false",
"name": "IsCompositeMeter"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsOnDemand"
},
{
"value": "true",
"name": "IsPeriodic"
},
{
"value": "false",
"name": "IsPrepaid"
},
{
"value": "false",
"name": "IsPrivate"
},
{
"value": "true",
"name": "IsPurchasedItemCyclePeriodic"
},
{
"value": "false",
"name": "IsRenewable"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "infinity",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "00217256_0001265248"
}
],
"bucketBalance": [
{
"remainingValueName": "0 megabytes",
"remainingValue": {
"amount": 0,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2025-06-18T00:00:00",
"endDateTime": "2025-07-18T00:00:00"
},
"characteristic": [
{
"value": "infinity",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "0 megabytes",
"remainingValue": {
"amount": 0,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2025-07-18T00:00:00",
"endDateTime": "2025-08-17T00:00:00"
},
"characteristic": [
{
"value": "infinity",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "true",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "0 megabytes",
"remainingValue": {
"amount": 0,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2025-08-17T00:00:00",
"endDateTime": "2025-09-16T00:00:00"
},
"characteristic": [
{
"value": "infinity",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "Notify_Gross,Notify_IncrEq,Notify_DecrEq",
"value": {
"amount": "infinity",
"units": "megabytes"
},
"valueName": "Credit Limit"
}
]
},
{
"id": "14",
"name": "RG20000 Data Usage Meter - Zero-Rated - Prepaid",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "0.0", //New mapping, amount or count associated with 'bucket.name'.
"name": "Amount"
},
{
"value": "infinity",
"name": "AvailableAmount"
},
{
"value": "2025-06-18T06:32:40",
"name": "BalanceStartTime"
},
{
"value": "2025-07-18T00:00:00",
"name": "StartTime"
},
{
"value": "2025-08-17T00:00:00",
"name": "EndTime"
},
{
"value": "infinity",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsBillingCyclePeriodic"
},
{
"value": "false",
"name": "IsCompositeMeter"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsOnDemand"
},
{
"value": "true",
"name": "IsPeriodic"
},
{
"value": "false",
"name": "IsPrepaid"
},
{
"value": "false",
"name": "IsPrivate"
},
{
"value": "true",
"name": "IsPurchasedItemCyclePeriodic"
},
{
"value": "false",
"name": "IsRenewable"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "infinity",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "00217256_0001265248"
}
],
"bucketBalance": [
{
"remainingValueName": "0 megabytes",
"remainingValue": {
"amount": 0,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2025-06-18T00:00:00",
"endDateTime": "2025-07-18T00:00:00"
},
"characteristic": [
{
"value": "infinity",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "0 megabytes",
"remainingValue": {
"amount": 0,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2025-07-18T00:00:00",
"endDateTime": "2025-08-17T00:00:00"
},
"characteristic": [
{
"value": "infinity",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "true",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "0 megabytes",
"remainingValue": {
"amount": 0,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2025-08-17T00:00:00",
"endDateTime": "2025-09-16T00:00:00"
},
"characteristic": [
{
"value": "infinity",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "Notify_Gross,Notify_IncrEq,Notify_DecrEq",
"value": {
"amount": "infinity",
"units": "megabytes"
},
"valueName": "Credit Limit"
}
]
},
{
"id": "16",
"name": "Included SMS - Prepaid",
"usageType": "Text",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "-999999.0", //New mapping, amount or count associated with 'bucket.name'.
"name": "Amount"
},
{
"value": "999999",
"name": "AvailableAmount"
},
{
"value": "2025-06-18T06:32:40",
"name": "BalanceStartTime"
},
{
"value": "2025-07-18T00:00:00",
"name": "StartTime"
},
{
"value": "2025-08-17T00:00:00",
"name": "EndTime"
},
{
"value": "0",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsBillingCyclePeriodic"
},
{
"value": "false",
"name": "IsCompositeMeter"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsOnDemand"
},
{
"value": "true",
"name": "IsPeriodic"
},
{
"value": "true",
"name": "IsPrepaid"
},
{
"value": "false",
"name": "IsPrivate"
},
{
"value": "true",
"name": "IsPurchasedItemCyclePeriodic"
},
{
"value": "false",
"name": "IsRenewable"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "999999",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "00217256_0001265248"
}
],
"bucketBalance": [
{
"remainingValueName": "999999",
"remainingValue": {
"amount": 999999
},
"validFor": {
"startDateTime": "2025-06-18T00:00:00",
"endDateTime": "2025-07-18T00:00:00"
},
"characteristic": [
{
"value": "999999",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "999999",
"remainingValue": {
"amount": 999999
},
"validFor": {
"startDateTime": "2025-07-18T00:00:00",
"endDateTime": "2025-08-17T00:00:00"
},
"characteristic": [
{
"value": "999999",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "true",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "0",
"remainingValue": {
"amount": 0
},
"validFor": {
"startDateTime": "2025-08-17T00:00:00",
"endDateTime": "2025-09-16T00:00:00"
},
"characteristic": [
{
"value": "0",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "Notify_Gross",
"value": {
"amount": 0,
"units": "none"
},
"valueName": "Bal"
}
]
},
{
"id": "17",
"name": "Included Minutes - Prepaid",
"usageType": "Voice",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "-999999.0", //New mapping, amount or count associated with 'bucket.name'.
"name": "Amount"
},
{
"value": "999999",
"name": "AvailableAmount"
},
{
"value": "2025-06-18T06:32:40",
"name": "BalanceStartTime"
},
{
"value": "2025-07-18T00:00:00",
"name": "StartTime"
},
{
"value": "2025-08-17T00:00:00",
"name": "EndTime"
},
{
"value": "0",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsBillingCyclePeriodic"
},
{
"value": "false",
"name": "IsCompositeMeter"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsOnDemand"
},
{
"value": "true",
"name": "IsPeriodic"
},
{
"value": "true",
"name": "IsPrepaid"
},
{
"value": "false",
"name": "IsPrivate"
},
{
"value": "true",
"name": "IsPurchasedItemCyclePeriodic"
},
{
"value": "false",
"name": "IsRenewable"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "999999",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "00217256_0001265248"
}
],
"bucketBalance": [
{
"remainingValueName": "999999 minutes",
"remainingValue": {
"amount": 999999,
"units": "minutes"
},
"validFor": {
"startDateTime": "2025-06-18T00:00:00",
"endDateTime": "2025-07-18T00:00:00"
},
"characteristic": [
{
"value": "999999",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "999999 minutes",
"remainingValue": {
"amount": 999999,
"units": "minutes"
},
"validFor": {
"startDateTime": "2025-07-18T00:00:00",
"endDateTime": "2025-08-17T00:00:00"
},
"characteristic": [
{
"value": "999999",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "true",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "0 minutes",
"remainingValue": {
"amount": 0,
"units": "minutes"
},
"validFor": {
"startDateTime": "2025-08-17T00:00:00",
"endDateTime": "2025-09-16T00:00:00"
},
"characteristic": [
{
"value": "0",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "Notify_Gross",
"value": {
"amount": 0,
"units": "minutes"
},
"valueName": "Bal"
},
{
"counterType": "Threshold_available_amount",
"level": "Notify_Gross",
"value": {
"amount": 100,
"units": "minutes"
},
"valueName": "recurring minutes threshold"
}
]
}
]
}
]Definitions
Each of the request parameters is detailed.
| name | type | description | required |
|---|---|---|---|
| description | string | Free short text describing the usage consumption report content | N |
| effectiveDate | datetime | Date and time when the usage consumption report was calculated and generated. | N |
| @type | string | Type of object | N |
| characteristic | array | A list of characteristics. Describes the characteristic of a billing account user. Please refer "Characteristic Values" table below for more details | N |
| characteristic.name | string | Name of the characteristic | N |
| characteristic.value | any | Value of the characteristic | N |
| bucket | array | A list of usage volume products (UsageVolumeProduct []). Bucket(s) included in the offer or option subscribed Note: This object will be repeated for each bucket item/ bundled product* | N |
| bucket.id | string | Unique identifier of the bucket | N |
| bucket.name | string | Bucket name | N |
| bucket.usageType | string | Type of usage concerned by the bucket, such as voice, sms, data, etc. | N |
| bucket.isShared | boolean | True if the bucket is shared between several devices or users. | N |
| bucket.@type | string | Bundle type | N |
| bucket.characteristic | array | A list of characteristics. Describes the characteristic of a bucket. Please refer "Bucket Characteristic Values" table below for more details | N |
| bucket.characteristic.name | string | Name of the characteristic | N |
| bucket.characteristic.value | any | Value of the characteristic | N |
| bucket.product | array | product Info of bucket | N |
| bucket.product.publicIdentifier | string | Public number associated to the network product (msisdn number for mobile line for example). | N |
| bucket.bucketCounter | array | The consumption counters detail for example the different kind of consumption done on the bucket | N |
| bucket.bucketCounter.counterType | string | Type of the consumption counter. We can give for example a counter of the used value for a bucket (counterType=used for example) | N |
| bucket.bucketCounter.level | string | Counter level. | N |
| bucket.bucketCounter.value | object | N | |
| bucket.bucketCounter.value.amount | number | Numeric used value for the bucket given in the unit. | N |
| bucket.bucketCounter.value.units | string | Numeric used value units for the bucket | N |
| bucket.bucketCounter.valueName | string | Used value in a formatted string for the bucket given in the counter unit | N |
Characteristic Values
| characteristic name | type | description | required |
|---|---|---|---|
| BillingCycleId | any | Billing Cycle Id | N |
| BillingIntervalId | any | Billing Interval Id | N |
| CurrentPeriodDuration | any | Current Period Duration | N |
| CurrentPeriodOffset | any | Current Period Offset | N |
| CurrentPeriodStartTime | datetime | Current Period Start Time | N |
| CurrentPeriodEndTime | datetime | Current Period End Time | N |
Bucket Characteristic Values
| characteristic name | type | description | required |
|---|---|---|---|
| AvailableAmount | string | balance credit limit | N |
| BalanceStartTime | string | BalanceStartTime | N |
| BalanceStartTime | string | BalanceStartTime | N |
| StartTime | datetime | StartTime | N |
| EndTime | datetime | EndTime | N |
| CreditLimit | string | CreditLimit | N |
| IsBillingCyclePeriodic | string | IsBillingCyclePeriodic | N |
| IsCompositeMeter | string | IsCompositeMeter | N |
| IsCreateExternalPaymentRequest | string | IsCreateExternalPaymentRequest | N |
| IsOnDemand | string | IsOnDemand | N |
| IsPeriodic | string | IsPeriodic | N |
| IsPrepaid | string | IsPrepaid | N |
| IsPrivate | string | IsPrivate | N |
| IsPurchasedItemCyclePeriodic | string | IsPurchasedItemCyclePeriodic | N |
| IsRenewable | string | IsRenewable | N |
| IsVirtual | string | IsVirtual | N |
| ReservedAmount | string | ReservedAmount | N |
| RolloverInitAmountTotal | string | RolloverInitAmountTotal | N |
| ThresholdLimit | string | ThresholdLimit | N |
| ReservedAmount | string | ReservedAmount | N |
| ThresholdLimit | string | ThresholdLimit | N |
| Amount | string | Represents the amount or count associated with each bucket product. | N |
Possible response error
In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.
[ 400 ]
Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.
{
"errors" : [{
"code" : 400,
"message" : "The request is invalid or not properly formed.",
"description" : "Malformed request syntax, invalid request message framing, or deceptive request routing."
}]
}[ 401 ]
Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.
{
"errors" : [{
"code" : 401,
"message" : "The user could not be authenticated for this request.",
"description" : "The request has not been applied because it lacks valid authentication credentials for the target resource"
}]
}[ 403 ]
Forbidden - Indicates that the server understood the request but refuses to fulfill it. If authentication credentials were provided in the request, the server considers them insufficient to grant access. The client SHOULD NOT automatically repeat the request with the same credentials. The client MAY repeat the request with new or different credentials.
[ 404 ]
Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.
{
"errors" : [{
"code" : 404,
"message" : "MATRIXX:QUERY_USAGE_ERROR",
"description" : "Subscriber not found (ExternalId=xxxx)"
}]
}[ 405 ]
Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
{
"errors": [{
"code": 405,
"message": "APIKIT:METHOD_NOT_ALLOWED",
"description": "HTTP Method xxx not allowed for : /{businessId}/usageConsumptionReport"
}]
}[ 500 ]
Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.
{
"errors" : [{
"code" : 500,
"message" : "Internal Server Error",
"description": "The request failed due to an internal error."
}]
}[ 502]
Bad Gateway - gateway is available but backend service is not. The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request.
[ 503 ]
Service Unavailable - temporary maintenance of service, try again later. The implication is that this is a temporary condition which will be alleviated after some delay. If known, the length of the delay will be indicated in a Retry-After header. If no Retry-After is given, the client SHOULD handle the response as it would for a 500 response. Note: The existence of the 503 status code does not imply that a server will use it when becoming overloaded. Servers may simply refuse the connection.
Retry-After: 120